broccoli-merge-trees

What is broccoli-merge-trees?

The broccoli-merge-trees npm package is used to merge multiple Broccoli trees into a single tree. This is useful in build processes where you need to combine outputs from different sources or plugins into one cohesive output.

What are broccoli-merge-trees's main functionalities?

Basic Merge

This feature allows you to merge two or more trees into a single tree. The code sample demonstrates merging two trees located at 'path/to/tree1' and 'path/to/tree2'.

const mergeTrees = require('broccoli-merge-trees');
const tree1 = 'path/to/tree1';
const tree2 = 'path/to/tree2';
const mergedTree = mergeTrees([tree1, tree2]);

Overwrite Option

This feature allows you to specify whether files in later trees should overwrite files in earlier trees. The code sample demonstrates merging two trees with the overwrite option set to true.

const mergeTrees = require('broccoli-merge-trees');
const tree1 = 'path/to/tree1';
const tree2 = 'path/to/tree2';
const mergedTree = mergeTrees([tree1, tree2], { overwrite: true });

Annotation

This feature allows you to add an annotation to the merged tree for easier debugging and logging. The code sample demonstrates merging two trees with an annotation 'Merged Trees'.

const mergeTrees = require('broccoli-merge-trees');
const tree1 = 'path/to/tree1';
const tree2 = 'path/to/tree2';
const mergedTree = mergeTrees([tree1, tree2], { annotation: 'Merged Trees' });

Other packages similar to broccoli-merge-trees

broccoli-concat

The broccoli-concat package is used to concatenate multiple files into a single file. While broccoli-merge-trees combines entire trees, broccoli-concat focuses on combining file contents. This can be useful for tasks like combining JavaScript or CSS files.

broccoli-funnel

The broccoli-funnel package allows you to filter and move files within a tree. It provides more granular control over the contents of a tree compared to broccoli-merge-trees, which merges entire trees. This can be useful for tasks like copying specific files or directories.

broccoli-stew

The broccoli-stew package offers a collection of Broccoli plugins for various tasks, including file manipulation, logging, and debugging. It provides more specialized functionalities compared to the general tree merging capabilities of broccoli-merge-trees.

README

broccoli-merge-trees

Copy multiple trees of files on top of each other, resulting in a single merged tree.

Installation

npm install --save-dev broccoli-merge-trees

Usage

• As a function call

const broccoliMergeTrees = require('broccoli-merge-trees');

let mergedNode = broccoliMergeTrees(inputNodes, options);

• With new

const { MergeTrees } = require('broccoli-merge-trees');

let mergedNode = new MergeTrees(inputNodes, options);

• inputNodes: An array of nodes, whose contents will be merged

• options: A hash of options

Options

• overwrite: By default, broccoli-merge-trees throws an error when a file exists in multiple nodes. If you pass { overwrite: true }, the output will contain the version of the file as it exists in the last input node that contains it.

• annotation: A note to help tell multiple plugin instances apart.

• destDir: A string representing the destination path that merged files will be copied to.

Example

If this is your Brocfile.js:

const mergeTrees = require('broccoli-merge-trees');

module.exports = function() {
  return mergeTrees(['public','scripts']);
};

And your project contains these files:

.
├─ public
│  ├─ index.html
│  └─ images
│     └─ logo.png
├─ scripts
│  └─ app.js
├─ Brocfile.js
…

Then running broccoli build the-output will generate this folder:

the-output
├─ app.js
├─ index.html
└─ images
   └─ logo.png

The parent folders, public and scripts in this case, are not included in the output. The output tree contains only the files within each folder, all mixed together.

---

If this is your Brocfile.js:

var BroccoliMergeTrees = require('broccoli-merge-trees');

module.exports = new BroccoliMergeTrees(['public', 'scripts'], {
    destDir: 'assets'
});

Then running broccoli build the-output will generate this folder:

the-output
└─ assets
    ├─ app.js
    ├─ index.html
    └─ images
    └─ logo.png

Contributing

Clone this repo and run the tests like so:

npm install
npm test

Issues and pull requests are welcome. If you change code, be sure to re-run npm test. Oftentimes it's useful to add or update tests as well.

Changelog

4.2.0

• Use new public location for volta-cli/action
• switch to GH actions
• bump all dependencies